docs: add initial Jupyter Book documentation scaffold - #322
Closed
yukthagangadhari5 wants to merge 3 commits into
Closed
docs: add initial Jupyter Book documentation scaffold#322yukthagangadhari5 wants to merge 3 commits into
yukthagangadhari5 wants to merge 3 commits into
Conversation
Collaborator
Author
|
Hi! I had opened PR #322 proposing a small Jupyter Book documentation scaffold (index, quickstart, config, toc), but it was closed with the suggestion to contribute here instead. I'd be happy to integrate those changes into this PR if they are useful. The goal was mainly to provide a minimal Quickstart page and documentation structure aligned with the Jupyter Book direction discussed in Issue #61. Please let me know if you'd like me to adapt the changes to match the structure in this PR. |
Collaborator
This was referenced Mar 30, 2026
Initial documentation improvement and setup groundwork, Added initial documentation improvement
#549
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Describe your changes
This PR introduces an initial Jupyter Book scaffold to structure project documentation.
Specifically, it adds:
_config.yml for Jupyter Book configuration
_toc.yml to define documentation structure
index.md as the documentation landing page
quickstart.md with a minimal usage example for metrics
The goal is to establish a foundation for structured documentation generation, aligned with the discussion in Issue #61 regarding automated documentation workflows.
This PR does not modify existing source code.
Issue Link
Related to #61
Type of change
🐛 Bug fix
✨ New feature
💥 Breaking change
📖 Documentation
Checklist before requesting a review
My branch is up-to-date with the target branch
I have performed a self-review of my changes
I have updated the README (not required for this scaffold PR)
I have added tests (not applicable – documentation change)
You do NOT need to fill reviewer/assignee checklist — that’s for maintainers.